<?php
/**
 * Zend Framework
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * http://framework.zend.com/license/new-bsd
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@zend.com so we can send you a copy immediately.
 *
 * @category   Zend
 * @package    Zend_Test
 * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 * @version    $Id: Redirect.php 16874 2009-07-20 12:46:00Z mikaelkael $
 */

/** PHPUnit_Framework_Constraint */
require_once 'PHPUnit/Framework/Constraint.php';

/**
 * Redirection constraints
 *
 * @uses       PHPUnit_Framework_Constraint
 * @package    Zend_Test
 * @subpackage PHPUnit
 * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
class Zend_Test_PHPUnit_Constraint_Redirect extends PHPUnit_Framework_Constraint
{
	/**#@+
	 * @const string Assertion type constants
	 */
	const ASSERT_REDIRECT       = 'assertRedirect';
	const ASSERT_REDIRECT_TO    = 'assertRedirectTo';
	const ASSERT_REDIRECT_REGEX = 'assertRedirectRegex';
	/**#@-*/

	/**
	 * Current assertion type
	 * @var string
	 */
	protected $_assertType      = null;

	/**
	 * Available assertion types
	 * @var array
	 */
	protected $_assertTypes     = array(
	self::ASSERT_REDIRECT,
	self::ASSERT_REDIRECT_TO,
	self::ASSERT_REDIRECT_REGEX,
	);

	/**
	 * Pattern to match against
	 * @var string
	 */
	protected $_match             = null;

	/**
	 * Whether or not assertion is negated
	 * @var bool
	 */
	protected $_negate            = false;

	/**
	 * Constructor; setup constraint state
	 *
	 * @return void
	 */
	public function __construct()
	{
	}

	/**
	 * Indicate negative match
	 *
	 * @param  bool $flag
	 * @return void
	 */
	public function setNegate($flag = true)
	{
		$this->_negate = $flag;
	}

	/**
	 * Evaluate an object to see if it fits the constraints
	 *
	 * @param  string $other String to examine
	 * @param  null|string Assertion type
	 * @return bool
	 */
	public function evaluate($other, $assertType = null)
	{
		if (!$other instanceof Zend_Controller_Response_Abstract) {
			require_once 'Zend/Test/PHPUnit/Constraint/Exception.php';
			throw new Zend_Test_PHPUnit_Constraint_Exception('Redirect constraint assertions require a response object');
		}

		if (strstr($assertType, 'Not')) {
			$this->setNegate(true);
			$assertType = str_replace('Not', '', $assertType);
		}

		if (!in_array($assertType, $this->_assertTypes)) {
			require_once 'Zend/Test/PHPUnit/Constraint/Exception.php';
			throw new Zend_Test_PHPUnit_Constraint_Exception(sprintf('Invalid assertion type "%s" provided to %s constraint', $assertType, __CLASS__));
		}

		$this->_assertType = $assertType;

		$response = $other;
		$argv     = func_get_args();
		$argc     = func_num_args();

		switch ($assertType) {
			case self::ASSERT_REDIRECT_TO:
				if (3 > $argc) {
					require_once 'Zend/Test/PHPUnit/Constraint/Exception.php';
					throw new Zend_Test_PHPUnit_Constraint_Exception('No redirect URL provided against which to match');
				}
				$this->_match = $match = $argv[2];
				return ($this->_negate)
				? $this->_notMatch($response, $match)
				: $this->_match($response, $match);
			case self::ASSERT_REDIRECT_REGEX:
				if (3 > $argc) {
					require_once 'Zend/Test/PHPUnit/Constraint/Exception.php';
					throw new Zend_Test_PHPUnit_Constraint_Exception('No pattern provided against which to match redirect');
				}
				$this->_match = $match = $argv[2];
				return ($this->_negate)
				? $this->_notRegex($response, $match)
				: $this->_regex($response, $match);
			case self::ASSERT_REDIRECT:
			default:
				return ($this->_negate) ? !$response->isRedirect() : $response->isRedirect();
		}
	}

	/**
	 * Report Failure
	 *
	 * @see    PHPUnit_Framework_Constraint for implementation details
	 * @param  mixed $other
	 * @param  string $description Additional message to display
	 * @param  bool $not
	 * @return void
	 * @throws PHPUnit_Framework_ExpectationFailedException
	 */
	public function fail($other, $description, $not = false)
	{
		require_once 'Zend/Test/PHPUnit/Constraint/Exception.php';
		switch ($this->_assertType) {
			case self::ASSERT_REDIRECT_TO:
				$failure = 'Failed asserting response redirects to "%s"';
				if ($this->_negate) {
					$failure = 'Failed asserting response DOES NOT redirect to "%s"';
				}
				$failure = sprintf($failure, $this->_match);
				break;
			case self::ASSERT_REDIRECT_REGEX:
				$failure = 'Failed asserting response redirects to URL MATCHING "%s"';
				if ($this->_negate) {
					$failure = 'Failed asserting response DOES NOT redirect to URL MATCHING "%s"';
				}
				$failure = sprintf($failure, $this->_match);
				break;
			case self::ASSERT_REDIRECT:
			default:
				$failure = 'Failed asserting response is a redirect';
				if ($this->_negate) {
					$failure = 'Failed asserting response is NOT a redirect';
				}
				break;
		}

		if (!empty($description)) {
			$failure = $description . "\n" . $failure;
		}

		throw new Zend_Test_PHPUnit_Constraint_Exception($failure);
	}

	/**
	 * Complete implementation
	 *
	 * @return string
	 */
	public function toString()
	{
		return '';
	}

	/**
	 * Check to see if content is matched in selected nodes
	 *
	 * @param  Zend_Controller_Response_HttpTestCase $response
	 * @param  string $match Content to match
	 * @return bool
	 */
	protected function _match($response, $match)
	{
		if (!$response->isRedirect()) {
			return false;
		}

		$headers  = $response->sendHeaders();
		$redirect = $headers['location'];
		$redirect = str_replace('Location: ', '', $redirect);

		return ($redirect == $match);
	}

	/**
	 * Check to see if content is NOT matched in selected nodes
	 *
	 * @param  Zend_Controller_Response_HttpTestCase $response
	 * @param  string $match
	 * @return bool
	 */
	protected function _notMatch($response, $match)
	{
		if (!$response->isRedirect()) {
			return true;
		}

		$headers  = $response->sendHeaders();
		$redirect = $headers['location'];
		$redirect = str_replace('Location: ', '', $redirect);

		return ($redirect != $match);
	}

	/**
	 * Check to see if content is matched by regex in selected nodes
	 *
	 * @param  Zend_Controller_Response_HttpTestCase $response
	 * @param  string $pattern
	 * @return bool
	 */
	protected function _regex($response, $pattern)
	{
		if (!$response->isRedirect()) {
			return false;
		}

		$headers  = $response->sendHeaders();
		$redirect = $headers['location'];
		$redirect = str_replace('Location: ', '', $redirect);

		return preg_match($pattern, $redirect);
	}

	/**
	 * Check to see if content is NOT matched by regex in selected nodes
	 *
	 * @param  Zend_Controller_Response_HttpTestCase $response
	 * @param  string $pattern
	 * @return bool
	 */
	protected function _notRegex($response, $pattern)
	{
		if (!$response->isRedirect()) {
			return true;
		}

		$headers  = $response->sendHeaders();
		$redirect = $headers['location'];
		$redirect = str_replace('Location: ', '', $redirect);

		return !preg_match($pattern, $redirect);
	}
}
